<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - FreshBooks_BaseInvoice</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/FreshBooks_BaseInvoice.html">FreshBooks_BaseInvoice</a></li>
	
	<li><a href="../symbols/FreshBooks_Category.html">FreshBooks_Category</a></li>
	
	<li><a href="../symbols/FreshBooks_Client.html">FreshBooks_Client</a></li>
	
	<li><a href="../symbols/FreshBooks_Element.html">FreshBooks_Element</a></li>
	
	<li><a href="../symbols/FreshBooks_Estimate.html">FreshBooks_Estimate</a></li>
	
	<li><a href="../symbols/FreshBooks_Expense.html">FreshBooks_Expense</a></li>
	
	<li><a href="../symbols/FreshBooks_HttpClient.html">FreshBooks_HttpClient</a></li>
	
	<li><a href="../symbols/FreshBooks_Invoice.html">FreshBooks_Invoice</a></li>
	
	<li><a href="../symbols/FreshBooks_Item.html">FreshBooks_Item</a></li>
	
	<li><a href="../symbols/FreshBooks_Payment.html">FreshBooks_Payment</a></li>
	
	<li><a href="../symbols/FreshBooks_Project.html">FreshBooks_Project</a></li>
	
	<li><a href="../symbols/FreshBooks_Recurring.html">FreshBooks_Recurring</a></li>
	
	<li><a href="../symbols/FreshBooks_Staff.html">FreshBooks_Staff</a></li>
	
	<li><a href="../symbols/FreshBooks_Task.html">FreshBooks_Task</a></li>
	
	<li><a href="../symbols/FreshBooks_TimeEntry.html">FreshBooks_TimeEntry</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class FreshBooks_BaseInvoice
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				<br />Extends
					<a href="../symbols/FreshBooks_Element.html">FreshBooks_Element</a>.<br />
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/D__Program Files_Apache Group_Apache_htdocs_ruka_development_freshbooks-api_js_library_FreshBooks_BaseInvoice.js.html">BaseInvoice.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class FreshBooks_BaseInvoice.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/FreshBooks_BaseInvoice.html">FreshBooks_BaseInvoice</a></b>()
							</div>
							<div class="description">FreshBooks BaseInvoice Class</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class FreshBooks_BaseInvoice.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/FreshBooks_BaseInvoice.html#lines">lines</a></b>
								</div>
								<div class="description">invoice lines (items)</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
				<dl class="inheritsList">
				
				</dl>
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class FreshBooks_BaseInvoice.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#asXML">asXML</a></b>()
								</div>
								<div class="description">return XML string</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#internalDelete">internalDelete</a></b>(responseStatus, XMLObject)
								</div>
								<div class="description">prepare XML string request for DELETE server method</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#internalLoadXML">internalLoadXML</a></b>(XMLObject)
								</div>
								<div class="description">load obect properties from SimpleXML object</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#internalPrepareCreate">internalPrepareCreate</a></b>(content)
								</div>
								<div class="description">prepare XML string request for CREATE server method</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#internalPrepareListing">internalPrepareListing</a></b>(filters, content)
								</div>
								<div class="description">prepare XML string request for LIST server method</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#internalPrepareSendByEmail">internalPrepareSendByEmail</a></b>(content)
								</div>
								<div class="description">internal hook to be implemented in child classes with particular logic to generate request for sendByEmail method</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#internalPrepareUpdate">internalPrepareUpdate</a></b>(content)
								</div>
								<div class="description">prepare XML string request for UPDATE server method</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#internalSendByEmail">internalSendByEmail</a></b>(responseStatus, XMLObject)
								</div>
								<div class="description">internal hook to be implemented in child classes with particular logic to process response XML from sendByEmail method</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#internalUpdate">internalUpdate</a></b>(responseStatus, XMLObject)
								</div>
								<div class="description">process XML string response from UPDATE server method</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#internalXMLContent">internalXMLContent</a></b>()
								</div>
								<div class="description">generate XML string from common properties</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#linesAsXML">linesAsXML</a></b>()
								</div>
								<div class="description">generate XML output from lines array</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#linksAsXML">linksAsXML</a></b>()
								</div>
								<div class="description">generate XML output from links properties</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#loadLines">loadLines</a></b>(XMLObject)
								</div>
								<div class="description">load lines array from XML object</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/FreshBooks_BaseInvoice.html#sendByEmail">sendByEmail</a></b>()
								</div>
								<div class="description">send invoice by email</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
				<dl class="inheritsList">
				<dt>Methods borrowed from class <a href="../symbols/FreshBooks_Element.html">FreshBooks_Element</a>: </dt><dd><a href="../symbols/FreshBooks_Element.html#create">create</a>, <a href="../symbols/FreshBooks_Element.html#del">del</a>, <a href="../symbols/FreshBooks_Element.html#get">get</a>, <a href="../symbols/FreshBooks_Element.html#getTagXML">getTagXML</a>, <a href="../symbols/FreshBooks_Element.html#getXMLElementValue">getXMLElementValue</a>, <a href="../symbols/FreshBooks_Element.html#getXMLNode">getXMLNode</a>, <a href="../symbols/FreshBooks_Element.html#internalCreate">internalCreate</a>, <a href="../symbols/FreshBooks_Element.html#internalGet">internalGet</a>, <a href="../symbols/FreshBooks_Element.html#internalListing">internalListing</a>, <a href="../symbols/FreshBooks_Element.html#internalPrepareDelete">internalPrepareDelete</a>, <a href="../symbols/FreshBooks_Element.html#internalPrepareGet">internalPrepareGet</a>, <a href="../symbols/FreshBooks_Element.html#listing">listing</a>, <a href="../symbols/FreshBooks_Element.html#loadXML">loadXML</a>, <a href="../symbols/FreshBooks_Element.html#processResponse">processResponse</a>, <a href="../symbols/FreshBooks_Element.html#requestEnvelope">requestEnvelope</a>, <a href="../symbols/FreshBooks_Element.html#sendRequest">sendRequest</a>, <a href="../symbols/FreshBooks_Element.html#update">update</a></dd>
				</dl>
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>FreshBooks_BaseInvoice</b>()
				</div>
				
				<div class="description">
					FreshBooks BaseInvoice Class
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name="lines"> </a>
					<div class="fixedFont">
					
					
					<b>lines</b>
					
					</div>
					<div class="description">
						invoice lines (items)
						
						
					</div>
					
					

						
						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="asXML"> </a>
					<div class="fixedFont">
					
					
					<b>asXML</b>()
					
					</div>
					<div class="description">
						return XML string
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="internalDelete"> </a>
					<div class="fixedFont">
					
					
					<b>internalDelete</b>(responseStatus, XMLObject)
					
					</div>
					<div class="description">
						prepare XML string request for DELETE server method
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>responseStatus</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<b>XMLObject</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="internalLoadXML"> </a>
					<div class="fixedFont">
					
					
					<b>internalLoadXML</b>(XMLObject)
					
					</div>
					<div class="description">
						load obect properties from SimpleXML object
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>XMLObject</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="internalPrepareCreate"> </a>
					<div class="fixedFont">
					
					
					<b>internalPrepareCreate</b>(content)
					
					</div>
					<div class="description">
						prepare XML string request for CREATE server method
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>content</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="internalPrepareListing"> </a>
					<div class="fixedFont">
					
					
					<b>internalPrepareListing</b>(filters, content)
					
					</div>
					<div class="description">
						prepare XML string request for LIST server method
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>filters</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<b>content</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="internalPrepareSendByEmail"> </a>
					<div class="fixedFont">
					
					
					<b>internalPrepareSendByEmail</b>(content)
					
					</div>
					<div class="description">
						internal hook to be implemented in child classes with particular logic to generate request for sendByEmail method
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>content</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="internalPrepareUpdate"> </a>
					<div class="fixedFont">
					
					
					<b>internalPrepareUpdate</b>(content)
					
					</div>
					<div class="description">
						prepare XML string request for UPDATE server method
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>content</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="internalSendByEmail"> </a>
					<div class="fixedFont">
					
					
					<b>internalSendByEmail</b>(responseStatus, XMLObject)
					
					</div>
					<div class="description">
						internal hook to be implemented in child classes with particular logic to process response XML from sendByEmail method
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>responseStatus</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<b>XMLObject</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="internalUpdate"> </a>
					<div class="fixedFont">
					
					
					<b>internalUpdate</b>(responseStatus, XMLObject)
					
					</div>
					<div class="description">
						process XML string response from UPDATE server method
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>responseStatus</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<b>XMLObject</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="internalXMLContent"> </a>
					<div class="fixedFont">
					
					
					<b>internalXMLContent</b>()
					
					</div>
					<div class="description">
						generate XML string from common properties
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="linesAsXML"> </a>
					<div class="fixedFont">
					
					
					<b>linesAsXML</b>()
					
					</div>
					<div class="description">
						generate XML output from lines array
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="linksAsXML"> </a>
					<div class="fixedFont">
					
					
					<b>linksAsXML</b>()
					
					</div>
					<div class="description">
						generate XML output from links properties
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="loadLines"> </a>
					<div class="fixedFont">
					
					
					<b>loadLines</b>(XMLObject)
					
					</div>
					<div class="description">
						load lines array from XML object
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>XMLObject</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="sendByEmail"> </a>
					<div class="fixedFont">
					
					
					<b>sendByEmail</b>()
					
					</div>
					<div class="description">
						send invoice by email
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			&copy;2009<br />
			Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 18:56:03 GMT+0100 (CET)
		</div>
	</body>
</html>
